Erc4626 extension #465

Ifechukwudaniel · 2024-12-19T06:20:07Z

Resolves #356

PR Checklist

Tests
Documentation
Changelog

netlify · 2024-12-19T06:20:25Z

✅ Deploy Preview for contracts-stylus canceled.

Name	Link
🔨 Latest commit	`8e4a720`
🔍 Latest deploy log	https://app.netlify.com/sites/contracts-stylus/deploys/676e8fe70a013b0008a1be33

Ifechukwudaniel · 2024-12-19T06:20:39Z

I just stared this

0xNeshi · 2024-12-19T07:38:13Z

I'll convert this to a draft, so that the team does not invest time reviewing a WIP

contracts/src/token/erc20/extensions/erc4626.rs

Ifechukwudaniel · 2024-12-19T09:49:22Z

@0xNeshi
The Solidity implementation uses safe transfer

SafeERC20.safeTransferFrom(_asset, caller, address(this), assets);

In the Solidity implementation, SafeERC20 is a utility library. However, in the Stylus implementation, SafeTransfer is a contract. What do you think

0xNeshi · 2024-12-19T10:42:02Z

@0xNeshi The Solidity implementation uses safe transfer
SafeERC20.safeTransferFrom(_asset, caller, address(this), assets);
In the Solidity implementation, SafeERC20 is a utility library. However, in the Stylus implementation, SafeTransfer is a contract. What do you think

See how VestingWallet handles this

Ifechukwudaniel · 2024-12-23T18:46:04Z

Should I implement something like mulDiv for U256 MATH?

function _convertToShares(uint256 assets, Math.Rounding rounding) internal view virtual returns (uint256) {
        return assets.mulDiv(totalSupply() + 10 ** _decimalsOffset(), totalAssets() + 1, rounding);
    }

@0xNeshi

Ifechukwudaniel · 2024-12-24T01:05:29Z

Should I add the security concerns like docs erc4626

0xNeshi · 2024-12-27T07:46:15Z

Should I add the security concerns like docs erc4626

I think that would be beneficial.

@qalisander @bidzyyys

0xNeshi

This is a good first draft, but there's still much work to be done before the PR is deemed "ready for review".

0xNeshi · 2024-12-27T08:01:10Z

Cargo.toml

@@ -13,6 +13,7 @@ members = [
  "examples/erc1155",
  "examples/erc1155-metadata-uri",
  "examples/erc1155-supply",
+  "examples/erc4262",  


Suggested change

"examples/erc4262",

"examples/erc4626",

it happens :D

Rename the example directory too

0xNeshi · 2024-12-27T08:01:50Z

Cargo.toml

@@ -13,6 +13,7 @@ members = [
  "examples/erc1155",
  "examples/erc1155-metadata-uri",
  "examples/erc1155-supply",
+  "examples/erc4262",  


Add the same member to default-members.

0xNeshi · 2024-12-27T08:10:12Z

benches/src/erc4626.rs

+sol!(
+    #[sol(rpc)]
+    contract Erc4626 {
+           function asset() public view  returns (address);


format Solidity code

0xNeshi · 2024-12-27T08:15:06Z

benches/src/erc4626.rs

+        function totalAssets() public view returns (uint256);
+        function convertToShares(uint256 assets) public view  returns (uint256);
+        function convertToAssets(uint256 shares) public view  returns (uint256);
+        function maxMint(address) public view  returns (uint256);


Suggested change

function maxMint(address) public view returns (uint256);

function maxMint(address receiver) public view returns (uint256);

nit: align function signatures - all functions should list the names of their arguments

0xNeshi · 2024-12-27T08:26:20Z

benches/src/erc4626.rs

+        function redeem(uint256 shares, address receiver) public  returns (uint256);
+        function withdraw(uint256 assets, address receiver) public  returns (uint256);


both of these are missing the owner parameter

0xNeshi · 2024-12-27T11:18:45Z

examples/erc4262/Cargo.toml

+
+[dependencies]
+openzeppelin-stylus.workspace = true
+alloy-primitives = { workspace = true, features = ["tiny-keccak"] }


Do you need the tiny-keccak feature?

0xNeshi · 2024-12-27T11:22:03Z

examples/erc4262/src/constructor.sol

+    constructor(address asset_) {
+        (bool success, uint8 assetDecimals) = _tryGetAssetDecimals();
+        _underlyingDecimals = success ? assetDecimals : 18;
+        _asset = asset_;
+    }
+
+    function _tryGetAssetDecimals() private pure returns (bool ok, uint8 assetDecimals) {
+       return (true, 0);
+    }


@bidzyyys @qalisander I think the example should contain the whole logic here:

constructor(IERC20 asset_) { (bool success, uint8 assetDecimals) = _tryGetAssetDecimals(asset_); _underlyingDecimals = success ? assetDecimals : 18; _asset = asset_; } /** * @dev Attempts to fetch the asset decimals. A return value of false indicates that the attempt failed in some way. */ function _tryGetAssetDecimals(IERC20 asset_) private view returns (bool ok, uint8 assetDecimals) { (bool success, bytes memory encodedDecimals) = address(asset_).staticcall( abi.encodeCall(IERC20Metadata.decimals, ()) ); if (success && encodedDecimals.length >= 32) { uint256 returnedDecimals = abi.decode(encodedDecimals, (uint256)); if (returnedDecimals <= type(uint8).max) { return (true, uint8(returnedDecimals)); } } return (false, 0); }

This should also be included in the docs as a note for lib users.

0xNeshi · 2024-12-27T11:22:23Z

examples/erc4262/src/lib.rs

+
+#[public]
+#[inherit(Erc20, Erc20Metadata, Erc4626)]
+impl Erc4262xample {


See #465 (comment)

0xNeshi · 2024-12-27T11:23:05Z

examples/erc4262/tests/abi/mod.rs

+
+
+
+        #[allow(missing_docs)]
+        event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);
+
+        #[allow(missing_docs)]
+        event Withdraw(address indexed sender,address indexed receiver,ddress indexed owner,uint256 assets, uint256 shares);


Format the Solidity code.

Remove unnecessary empty lines

0xNeshi · 2024-12-27T11:23:22Z

examples/erc4262/tests/erc4262.rs

+async fn error_when_exceeded_max_redeem(
+    alice: Account,
+    bob: Account,
+) -> Result<()> {


Implement e2e tests, and ensure they pass successfully.

CHANGELOG.md

0xNeshi · 2024-12-27T11:27:00Z

docs/modules/ROOT/pages/erc4262.adoc

@@ -0,0 +1,46 @@
+= ERC-4262
+
+https://eips.ethereum.org/EIPS/eip-4626[ERC-4626] is an extension of xref:erc20.adoc[ERC-20]  that proposes a standard interface for token vaults. This standard interface can be used by widely different contracts (including lending markets, aggregators, and intrinsically interest bearing tokens), which brings a number of subtleties. Navigating these potential issues is essential to implementing a compliant and composable token vault.


Response to #465 (comment):

Should I add the security concerns like docs erc4626

Yes 👍

0xNeshi · 2024-12-27T11:27:23Z

docs/modules/ROOT/pages/erc4262.adoc

+
+#[public]
+#[inherit(Erc20, Erc20Metadata, Erc4626)]
+impl Erc4262xample {


See #465 (comment)

0xNeshi · 2024-12-27T11:28:09Z

contracts/src/token/erc20/extensions/erc4626.rs

+    type Error: Into<alloc::vec::Vec<u8>>;
+
+    /// Returns the address of the underlying asset that the vault manages.
+    fn asset(&self) -> Address;


Double check all functions' docs for missing arguments.

Ensure your docs follow the existing convention, see other contracts for examples.

Ifechukwudaniel added 3 commits December 18, 2024 03:26

chore: started working on erc4626

3e8199b

chore: created file

953c56a

chore: changes

3782f6b

Ifechukwudaniel requested review from bidzyyys, qalisander and 0xNeshi as code owners December 19, 2024 06:20

Merge branch 'main' into ERC4626-Extension-

6e0ee98

0xNeshi marked this pull request as draft December 19, 2024 07:38

chore: valut

2a07b0f

0xNeshi reviewed Dec 19, 2024

View reviewed changes

contracts/src/token/erc20/extensions/erc4626.rs Outdated Show resolved Hide resolved

Ifechukwudaniel added 2 commits December 19, 2024 08:03

chore: added description

40df9d6

chore: renaned file

d32ea8a

0xNeshi self-requested a review December 19, 2024 09:26

Ifechukwudaniel added 2 commits December 19, 2024 10:15

chore: erc4262 file

8583606

chore: erc20 abi

6d21c4e

Ifechukwudaniel added 10 commits December 20, 2024 08:10

chore: revert file

ad8f0aa

chore: strorage types

75e7eeb

Merge branch 'main' into ERC4626-Extension-

8bed167

chore:merged changes

c6166c5

chore: enum

77831c9

chore: erc4626 funtions

dd266ae

chore: formated code

a6c6132

chore: test abi for erc4262

fea2fb1

chore: created error test funtions

51a17ca

chore:exported erc4262 example

c24bec7

Ifechukwudaniel added 3 commits December 23, 2024 23:07

chore: mulDiv funtion

8f80d54

chore: comments

01e989b

chore:example funtion

f50ef5d

Ifechukwudaniel marked this pull request as ready for review December 24, 2024 00:09

Ifechukwudaniel added 2 commits December 24, 2024 00:47

chore: docs files

e432b0d

chore: added log

f5404ef

Ifechukwudaniel added 8 commits December 24, 2024 05:00

chore :docs

990896a

chore: removed code line

7f7eeff

chore: erc4626 benches

b146ed1

chore: removed stuff

af1e7d0

chore: erc4626

765294e

chore: docs and package.lock

47ee983

chore: unit test max_mint

14c8462

chore: format code and unit test max deposit

d7939ea

0xNeshi assigned Ifechukwudaniel Dec 27, 2024

0xNeshi reviewed Dec 27, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

0xNeshi reviewed Dec 27, 2024

View reviewed changes

0xNeshi and others added 2 commits December 27, 2024 12:29

docs: Apply minor suggestions from code review

00274a9

Merge branch 'main' into ERC4626-Extension-

8e4a720

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Erc4626 extension #465

Erc4626 extension #465

Ifechukwudaniel commented Dec 19, 2024 •

edited

Loading

netlify bot commented Dec 19, 2024 •

edited

Loading

Ifechukwudaniel commented Dec 19, 2024

0xNeshi commented Dec 19, 2024

Ifechukwudaniel commented Dec 19, 2024

0xNeshi commented Dec 19, 2024 •

edited

Loading

Ifechukwudaniel commented Dec 23, 2024

Ifechukwudaniel commented Dec 24, 2024

0xNeshi commented Dec 27, 2024

0xNeshi left a comment

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024 •

edited

Loading

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024

0xNeshi Dec 27, 2024 •

edited

Loading

	function maxMint(address) public view returns (uint256);
	function maxMint(address receiver) public view returns (uint256);

		function redeem(uint256 shares, address receiver) public returns (uint256);
		function withdraw(uint256 assets, address receiver) public returns (uint256);

		@@ -0,0 +1,46 @@
		= ERC-4262

		https://eips.ethereum.org/EIPS/eip-4626[ERC-4626] is an extension of xref:erc20.adoc[ERC-20] that proposes a standard interface for token vaults. This standard interface can be used by widely different contracts (including lending markets, aggregators, and intrinsically interest bearing tokens), which brings a number of subtleties. Navigating these potential issues is essential to implementing a compliant and composable token vault.

Erc4626 extension #465

Are you sure you want to change the base?

Erc4626 extension #465

Conversation

Ifechukwudaniel commented Dec 19, 2024 • edited Loading

PR Checklist

netlify bot commented Dec 19, 2024 • edited Loading

✅ Deploy Preview for contracts-stylus canceled.

Ifechukwudaniel commented Dec 19, 2024

0xNeshi commented Dec 19, 2024

Ifechukwudaniel commented Dec 19, 2024

0xNeshi commented Dec 19, 2024 • edited Loading

Ifechukwudaniel commented Dec 23, 2024

Ifechukwudaniel commented Dec 24, 2024

0xNeshi commented Dec 27, 2024

0xNeshi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xNeshi Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xNeshi Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

Ifechukwudaniel commented Dec 19, 2024 •

edited

Loading

netlify bot commented Dec 19, 2024 •

edited

Loading

0xNeshi commented Dec 19, 2024 •

edited

Loading

0xNeshi Dec 27, 2024 •

edited

Loading

0xNeshi Dec 27, 2024 •

edited

Loading